Provisioning service principals

Provisioning Service Principals is required in order to turn on the Licensing settings that are used to activate the Workflow Manager and IEE's other add-on modules. IEE uses two Service Principals:

  • one to communicate with the Licensing API, and

  • another one to communicate with the Action Manager API.

Service Principals can be provisioned using the Tools section in the IEE Install Suite.

Note: Service Principal Provisioning is not required to successfully install IEE, but it is required to use IEE's licensing features.

Prerequisites

Itron Identity must be installed before provisioning Service Principals. Install Itron Platform before performing this procedure, as Itron Identity will be installed as part of Itron Platform. For details on installing Itron Platform, see the IEE Edge Explorer 2.4 Installation Guide.

  1. On the IEE installation package, go to the IEE Install Suite folder, and launch the IEE Install Suite installer.

  2. Double-click IEEInstallSuite.exe to open the file. This will start the extraction process for the contents of the installer. This may take several minutes.

  3. When the extraction process has completed, the User Account Control dialog will appear, click Yes.

    The User Account Control dialog.

  4. On the Itron Software License Agreement screen, read the agreement, select I accept the terms in the license agreement, and then click Next.

    The IEE Install Suite License Agreement screen.

    Note: You must install IEE Application Server before you can install additional products. 

  5. From the Tools dropdown menu, select Provisioning, and then click Next.

    The Tools dropdown menu on the Module Selection screen.

  6. In the Provision Service Principal for Licensing dialog section, complete the following fields:

    • Client ID. Used for requesting access tokens from the Identity Server to access Licensing APIs.

    • Client Scope. Used by the Identity Server to determine the access that will be granted to an access token.

    • Client Secret: Enter your client secret for the Identity Server. Client secrets have an expected minimal complexity:

      • Minimal length: 16

      • Maximal length: 32

      • Required characters: Lower case, Upper case, numbers.

    • Confirm Client Secret: Re-enter your client secret for the Identity Server.

    • License Gateway URL. Identifies the Licensing REST API used for license verification.

    • Token Generation URL. Identifies the Licensing REST API used for license token generation.

  7. In the Provisioning Service Principal for Workflow section, complete the following fields:

    • Action Manager Client ID

    • Client Secret

    • Confirm Client Secrets

  8. Click Provision.

    The location of the Provision button.

  9. When the provisioning completes, click the X to close the Provisioning dialog.

    Closing the Provisioning dialog.

  10. To verify the service provisioning installed correctly:

    1. Launch the IEE application.

    2. Go to System Administration > System Admin > System Settings.

    3. Click the Section dropdown menu and select Licensing. You should now see any add-on module settings you entered during this procedure.